gh-76595: Add note on PyCapsule_Import behavior
#134022
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There's a PR (pythonGH-6898) which changes this behavior (to be less surprising, I believe), but this seems to have stalled. See: python#76595 See: python#6898
ZeroIntensity
added
topic-C-API
needs backport to 3.13
Doc/c-api/capsule.rst
Outdated
| @@ -108,6 +108,14 @@ Refer to :ref:`using-capsules` for more information on using these objects. | |||
| Return the capsule's internal *pointer* on success. On failure, set an | |||
| exception and return ``NULL``. | |||
|
|
|||
| .. note:: | |||
|
|
|||
| :c:func:`PyCapsule_Import` splits *name* on the ``.`` character, and | |||
There was a problem hiding this comment.
We already know that it's PyCapsule_Import:
Suggested change
| :c:func:`PyCapsule_Import` splits *name* on the ``.`` character, and | |
| This function splits *name* on the ``.`` character, and |
Doc/c-api/capsule.rst
Outdated
| imports the first element. It then processes further elements using | ||
| attribute lookups. As a result, if *name* points to an attribute in | ||
| some submodule or subpackage, this submodule or subpackage must be | ||
| previously imported using other means (e.g. by using :c:func:`PyImport_ImportModule`). |
There was a problem hiding this comment.
Suggested change
| previously imported using other means (e.g. by using :c:func:`PyImport_ImportModule`). | |
| previously imported using other means (for example, by using :c:func:`PyImport_ImportModule`). |
Also needs to be wrapped.
|
Thanks for the feedback. I tried to handle both of the requested changes. |
ZeroIntensity
approved these changes
May 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was somewhat surprised by this behavior recently, so thought it'd be useful to have a note in the docs.
There's a PR (GH-6898) which changes this behavior (to be less surprising, I believe), but this seems to have stalled.
See: #76595
See: #6898
📚 Documentation preview 📚: https://cpython-previews--134022.org.readthedocs.build/en/134022/c-api/capsule.html#c.PyCapsule_Import